<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
 <head>
  <meta http-equiv="content-type" content="text/html; charset=UTF-8">
  <title>Constructs a new SyncEvent object</title>
<link media="all" rel="stylesheet" type="text/css" href="styles/03e73060321a0a848018724a6c83de7f-theme-base.css" />
<link media="all" rel="stylesheet" type="text/css" href="styles/03e73060321a0a848018724a6c83de7f-theme-medium.css" />

 </head>
 <body class="docs"><div class="navbar navbar-fixed-top">
  <div class="navbar-inner clearfix">
    <ul class="nav" style="width: 100%">
      <li style="float: left;"><a href="class.syncevent.html">« SyncEvent</a></li>
      <li style="float: right;"><a href="syncevent.fire.html">SyncEvent::fire »</a></li>
    </ul>
  </div>
</div>
<div id="breadcrumbs" class="clearfix">
  <ul class="breadcrumbs-container">
    <li><a href="index.html">PHP Manual</a></li>
    <li><a href="class.syncevent.html">SyncEvent</a></li>
    <li>Constructs a new SyncEvent object</li>
  </ul>
</div>
<div id="layout">
  <div id="layout-content"><div id="syncevent.construct" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">SyncEvent::__construct</h1>
  <p class="verinfo">(PECL sync &gt;= 1.0.0)</p><p class="refpurpose"><span class="refname">SyncEvent::__construct</span> &mdash; <span class="dc-title">Constructs a new SyncEvent object</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-syncevent.construct-description">
  <h3 class="title">说明</h3>
  <div class="methodsynopsis dc-description">
   <span class="modifier">public</span> <span class="methodname"><strong>SyncEvent::__construct</strong></span>(<span class="methodparam"><span class="type">string</span> <code class="parameter">$name</code><span class="initializer"> = ?</span></span>, <span class="methodparam"><span class="type">bool</span> <code class="parameter">$manual</code><span class="initializer"> = <strong><code>false</code></strong></span></span>, <span class="methodparam"><span class="type">bool</span> <code class="parameter">$prefire</code><span class="initializer"> = <strong><code>false</code></strong></span></span>)</div>

  <p class="para rdfs-comment">
   Constructs a named or unnamed event object.
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-syncevent.construct-parameters">
  <h3 class="title">参数</h3>
  <dl>
   
    <dt>
<code class="parameter">name</code></dt>

    <dd>

     <p class="para">
      The name of the event if this is a named event object.
     </p>
     <blockquote class="note"><p><strong class="note">注意</strong>: 
      <p class="para">
       If the name already exists, it must be able to be opened by the current user
       that the process is running as or an exception will be thrown with a meaningless
       error message.
      </p>
     </p></blockquote>
    </dd>

   
   
    <dt>
<code class="parameter">manual</code></dt>

    <dd>

     <p class="para">
      Specifies whether or not the event object must be reset manually.
     </p>
     <blockquote class="note"><p><strong class="note">注意</strong>: 
      <p class="para">
       Manual reset event objects allow all waiting processes through until the
       object is reset.
      </p>
     </p></blockquote>
    </dd>

   
   
    <dt>
<code class="parameter">prefire</code></dt>

    <dd>

     <p class="para">
      Specifies whether or not to prefire (signal) the event object.
     </p>
     <blockquote class="note"><p><strong class="note">注意</strong>: 
      <p class="para">
       Only has impact if the calling process/thread is the first to create the object.
      </p>
     </p></blockquote>
    </dd>

   
  </dl>

 </div>


 <div class="refsect1 returnvalues" id="refsect1-syncevent.construct-returnvalues">
  <h3 class="title">返回值</h3>
  <p class="para">
   The new <span class="classname"><a href="class.syncevent.html" class="classname">SyncEvent</a></span> object.
  </p>
 </div>


 <div class="refsect1 errors" id="refsect1-syncevent.construct-errors">
  <h3 class="title">错误／异常</h3>
  <p class="para">
   An exception is thrown if the event object cannot be created or opened.
  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-syncevent.construct-examples">
  <h3 class="title">范例</h3>
  <div class="example" id="example-3363">
   <p><strong>示例 #1 <span class="function"><strong>SyncEvent::__construct()</strong></span> example</strong></p>
   <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB">&lt;?php<br /></span><span style="color: #FF8000">//&nbsp;In&nbsp;a&nbsp;web&nbsp;application:<br /></span><span style="color: #0000BB">$event&nbsp;</span><span style="color: #007700">=&nbsp;new&nbsp;</span><span style="color: #0000BB">SyncEvent</span><span style="color: #007700">(</span><span style="color: #DD0000">"GetAppReport"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$event</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">fire</span><span style="color: #007700">();<br /><br /></span><span style="color: #FF8000">//&nbsp;In&nbsp;a&nbsp;cron&nbsp;job:<br /></span><span style="color: #0000BB">$event&nbsp;</span><span style="color: #007700">=&nbsp;new&nbsp;</span><span style="color: #0000BB">SyncEvent</span><span style="color: #007700">(</span><span style="color: #DD0000">"GetAppReport"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$event</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">wait</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">?&gt;</span>
</span>
</code></div>
   </div>

  </div>
 </div>


 <div class="refsect1 changelog" id="refsect1-syncevent.construct-changelog">
  <h3 class="title">更新日志</h3>
  <p class="para">
   <table class="doctable informaltable">
    
     <thead>
      <tr>
       <th>版本</th>
       <th>说明</th>
      </tr>

     </thead>

     <tbody class="tbody">
      <tr>
       <td>PECL sync 1.1.0</td>
       <td>
        <p class="para">
         Added <code class="parameter">prefire</code>.
        </p>
       </td>
      </tr>

     </tbody>
    
   </table>

  </p>
 </div>


 <div class="refsect1 seealso" id="refsect1-syncevent.construct-seealso">
  <h3 class="title">参见</h3>
  <ul class="simplelist">
   <li class="member"><span class="methodname"><a href="syncevent.fire.html" class="methodname" rel="rdfs-seeAlso">SyncEvent::fire()</a> - Fires/sets the event</span></li>
   <li class="member"><span class="methodname"><a href="syncevent.reset.html" class="methodname" rel="rdfs-seeAlso">SyncEvent::reset()</a> - Resets a manual event</span></li>
   <li class="member"><span class="methodname"><a href="syncevent.wait.html" class="methodname" rel="rdfs-seeAlso">SyncEvent::wait()</a> - Waits for the event to be fired/set</span></li>
  </ul>
 </div>


</div></div></div></body></html>